API Gateway で誤ったパスへのリクエストを記録する方法を教えてください

AWSテクニカルサポートノート

#AWS

#Amazon API Gateway

Nakamura Makoto

2023.05.16

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

困っていた内容

API Gateway へのリクエストのテストを実施しています。
テスト時に、誤ったパスへのリクエストも実施したのですが、実行ログにはリクエストの記録がありませんでした。

API Gateway で誤ったパスへのリクエストを記録する方法を教えてください。

どう対応すればいいの？

API Gateway のアクセスログを有効化してください。

アクセスログの作成では、API デベロッパーとして、API にアクセスしたユーザーと、呼び出し元が API にアクセスした方法を記録します。

API Gateway には実行ログとアクセスログの 2 種類があります。
実行ログでは API Gateway によってロググループが作成され、出力されるログも API Gateway によって決められています。
一方、アクセスログではユーザーがロググループを作成し、ログの形式や内容を変更することが可能です。

アクセスログを有効化したうえで、誤ったパスへリクエストを実行すると以下のようなログが記録されます。

{
    "requestId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "ip": "xx.x.xxx.xxx",
    "caller": "-",
    "user": "-",
    "requestTime": "16/Feb/2023:12:36:41 +0000",
    "httpMethod": "GET",
    "resourcePath": "/dev/test",
    "status": "403",
    "protocol": "HTTP/1.1",
    "responseLength": "42"
}